home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr48 / vdl020d.zip / VDOS.DOC < prev    next >
Text File  |  1993-04-14  |  10KB  |  442 lines
  1. {
  2.  ════════════════════════════════════════════════════════════════════════════
  3.  
  4.  Visionix DOS Mid-Level Unit (VDOS)
  5.  Copyright 1991,92,93 Visionix
  6.  ALL RIGHTS RESERVED
  7.  
  8.  ────────────────────────────────────────────────────────────────────────────
  9.  
  10.  Revision history in reverse chronological order:
  11.  
  12.  Initials  Date      Comment
  13.  ────────  ────────  ────────────────────────────────────────────────────────
  14.  
  15.  lpg       03/25/93  Fixed DOS_GetMediaID, DOS_SetMediaID and made sure
  16.                        they indicated the Drive Number.
  17.  
  18.  lpg       03/15/93  Added Source Documentation
  19.  
  20.  mep       02/11/93  Cleaned up code for beta release
  21.  
  22.  jrt       02/08/93  Sync with beta 0.12 release
  23.  
  24.  lpg       12/08/92  Created
  25.  
  26.  ════════════════════════════════════════════════════════════════════════════
  27. }
  28.  
  29. Unit VDos;
  30.  
  31.  
  32. Uses
  33.  
  34.   DOS;
  35.  
  36. {────────────────────────────────────────────────────────────────────────────}
  37.  
  38. Procedure DOS_GetData(        Var Version        : WORD;
  39.                               Var OEM            : BYTE;
  40.                               Var Serial         : LONGINT   );
  41.  
  42. Function  DOS_GetVersion                                       : WORD;
  43.  
  44. Function  DOS_GetOEM                                           : BYTE;
  45.  
  46. Function  DOS_GetSerial                                        : LONGINT;
  47.  
  48. Function  DOS_GetStartupDrive                                  : BYTE;
  49.  
  50. Function  DOS_GetMSDOSVersion(Var DosInHMA       : BOOLEAN;
  51.                               Var Revision       : BYTE      ) : WORD;
  52.  
  53. Function  DOS_GetDiskSpaceFree(   Drive          : BYTE      ) : LONGINT;
  54.  
  55. Function  DOS_GetDevInputStatus(  Handle         : WORD;
  56.                               Var Status         : BYTE      ) : BYTE;
  57.  
  58. Function  DOS_GetDevOutputStatus( Handle         : WORD;
  59.                               Var Status         : BYTE      ) : BYTE;
  60.  
  61. Function  DOS_IsRemovMediaDev(    Drive          : BYTE;
  62.                               Var Remov          : BOOLEAN   ) : WORD;
  63.  
  64. Function  DOS_GetMediaID(         Drive          : BYTE;
  65.                               Var InfoLevel      : WORD;
  66.                               Var SerialNbr      : LONGINT;
  67.                               Var VolLabel       : STRING;
  68.                               Var FileSysType    : STRING    ) : WORD;
  69.  
  70. Function  DOS_SetMediaID(         Drive          : BYTE;
  71.                                   InfoLevel      : WORD;
  72.                                   SerialNbr      : LONGINT;
  73.                                   VolLabel       : STRING;
  74.                                   FileSysType    : STRING    ) : WORD;
  75.  
  76. Function  DOS_GetExtErrText(  VAR Description    : STRING;
  77.                               VAR ErrCause       : STRING;
  78.                               VAR Recommend      : STRING;
  79.                               VAR ErrSource      : STRING    ) : WORD;
  80.  
  81. {────────────────────────────────────────────────────────────────────────────}
  82.  
  83.  
  84. ──────────────────────────────────────────────────────────────────────────────
  85.  
  86.  
  87. [FUNCTION]
  88.  
  89. Procedure DOS_GetData(        Var Version        : WORD;
  90.                               Var OEM            : BYTE;
  91.                               Var Serial         : LONGINT   );
  92.  
  93. [PARAMETERS]
  94.  
  95. Version     VAR Returned Dos Version
  96. OEM         VAR Returned Dos OEM Code
  97. Serial      VAR Returned Dos Serial Number
  98.  
  99. [RETURNS]
  100.  
  101. (Function : None)
  102. (VAR : [Version] Dos Version)
  103. (VAR : [OEM] Dos OEM Code)
  104. (VAR : [Serial] Dos Serial Number)
  105.  
  106. [DESCRIPTION]
  107.  
  108. [SEE-ALSO]
  109.  
  110. [EXAMPLE]
  111.  
  112.  
  113. ──────────────────────────────────────────────────────────────────────────────
  114.  
  115.  
  116. [FUNCTION]
  117.  
  118. Function DOS_GetVersion                                        : WORD;
  119.  
  120. [PARAMETERS]
  121.  
  122. (None)
  123.  
  124. [RETURNS]
  125.  
  126. Dos Version
  127.  
  128. [DESCRIPTION]
  129.  
  130. [SEE-ALSO]
  131.  
  132. [EXAMPLE]
  133.  
  134.  
  135. ──────────────────────────────────────────────────────────────────────────────
  136.  
  137.  
  138. [FUNCTION]
  139.  
  140. Function DOS_GetOEM                                            : BYTE;
  141.  
  142. [PARAMETERS]
  143.  
  144. (None)
  145.  
  146. [RETURNS]
  147.  
  148. Dos OEM Code
  149.  
  150. [DESCRIPTION]
  151.  
  152. [SEE-ALSO]
  153.  
  154. [EXAMPLE]
  155.  
  156.  
  157. ──────────────────────────────────────────────────────────────────────────────
  158.  
  159.  
  160. [FUNCTION]
  161.  
  162. Function DOS_GetSerial                                         : LONGINT;
  163.  
  164. [PARAMETERS]
  165.  
  166. (None)
  167.  
  168. [RETURNS]
  169.  
  170. Dos Serial Number
  171.  
  172. [DESCRIPTION]
  173.  
  174. [SEE-ALSO]
  175.  
  176. [EXAMPLE]
  177.  
  178.  
  179. ──────────────────────────────────────────────────────────────────────────────
  180.  
  181.  
  182. [FUNCTION]
  183.  
  184. Function DOS_GetStartupDrive                                   : BYTE;
  185.  
  186. [PARAMETERS]
  187.  
  188. (None)
  189.  
  190. [RETURNS]
  191.  
  192. Start up Drive Number (1=A,2=B,...)
  193.  
  194. [DESCRIPTION]
  195.  
  196. [SEE-ALSO]
  197.  
  198. [EXAMPLE]
  199.  
  200.  
  201. ──────────────────────────────────────────────────────────────────────────────
  202.  
  203.  
  204. [FUNCTION]
  205.  
  206. Function DOS_GetMSDOSVersion( Var DosInHMA       : BOOLEAN;
  207.                               Var Revision       : BYTE      ) : WORD;
  208.  
  209. [PARAMETERS]
  210.  
  211. DosInHMA    VAR Returned Is DOS Loaded in High Memory?
  212. Revision    VAR Returned DOS Revision
  213.  
  214. [RETURNS]
  215.  
  216. (Function : Operation Error Code) (0=Success)
  217. (VAR      : [DosInHMA] Is DOS Loaded in High Memory?)
  218. (VAR      : [Revision] DOS Revision)
  219.  
  220. [DESCRIPTION]
  221.  
  222. [SEE-ALSO]
  223.  
  224. [EXAMPLE]
  225.  
  226.  
  227. ──────────────────────────────────────────────────────────────────────────────
  228.  
  229.  
  230. [FUNCTION]
  231.  
  232. Function DOS_GetDiskSpaceFree(    Drive          : BYTE      ) : LONGINT;
  233.  
  234. [PARAMETERS]
  235.  
  236. Drive       Drive Number (+80h for HD)
  237.  
  238. [RETURNS]
  239.  
  240. Free Space on Selected Drive
  241.  
  242. [DESCRIPTION]
  243.  
  244. [SEE-ALSO]
  245.  
  246. [EXAMPLE]
  247.  
  248.  
  249. ──────────────────────────────────────────────────────────────────────────────
  250.  
  251.  
  252. [FUNCTION]
  253.  
  254. Function DOS_GetDevInputStatus( Handle    : WORD;
  255.                             Var Status    : BYTE      ) : BYTE;
  256.  
  257. [PARAMETERS]
  258.  
  259. Handle      Device or File Handle
  260. Status      VAR Returned Device or File Input Status Code
  261.  
  262. [RETURNS]
  263.  
  264. (Function : Operation Error Code) (0=Success)
  265. (VAR      : [Status] Device or File Input Status Code)
  266.  
  267. [DESCRIPTION]
  268.  
  269. Status returns as follows:
  270.  
  271.   Devices:  $00 = Not Ready,      $FF = Ready
  272.   Files  :  $00 = Pointer at EOF, $FF = Ready
  273.  
  274. [SEE-ALSO]
  275.  
  276. [EXAMPLE]
  277.  
  278.  
  279. ──────────────────────────────────────────────────────────────────────────────
  280.  
  281.  
  282. [FUNCTION]
  283.  
  284. Function DOS_GetDevOutputStatus(  Handle         : WORD;
  285.                               Var Status         : BYTE      ) : BYTE;
  286.  
  287. [PARAMETERS]
  288.  
  289. Handle      Device or File Handle
  290. Status      VAR Returned Device or File Output Status Code
  291.  
  292. [RETURNS]
  293.  
  294. (Function : Operation Error Code) (0=Success)
  295. (VAR      : [Status] Device or File Output Status Code)
  296.  
  297. [DESCRIPTION]
  298.  
  299. Status returns as follows:
  300.  
  301.    Devices:  $00 = Not Ready,  $FF = Ready
  302.    Files  :  $00 = Ready,      $FF = Ready
  303.  
  304. [SEE-ALSO]
  305.  
  306. [EXAMPLE]
  307.  
  308.  
  309. ──────────────────────────────────────────────────────────────────────────────
  310.  
  311.  
  312. [FUNCTION]
  313.  
  314. Function DOS_IsRemovMediaDev(     Drive          : BYTE;
  315.                               Var Remov          : BOOLEAN   ) : WORD;
  316.  
  317. [PARAMETERS]
  318.  
  319. Drive       Selected Drive Number
  320. Remov       VAR Returned Is Media Removable? (TRUE=Yes)
  321.  
  322. [RETURNS]
  323.  
  324. (Function : Operation Error Code)
  325. (VAR      : [Remov] Is Media Removable?)
  326.  
  327. [DESCRIPTION]
  328.  
  329. Tests if Device is a Removable Media Device and returns the Results.
  330. TRUE=Removable Media Device, FALSE=Fixed Media Device
  331.  
  332. [SEE-ALSO]
  333.  
  334. [EXAMPLE]
  335.  
  336.  
  337. ──────────────────────────────────────────────────────────────────────────────
  338.  
  339.  
  340. [FUNCTION]
  341.  
  342. Function DOS_GetMediaID(          Drive          : BYTE;
  343.                               Var InfoLevel      : WORD;
  344.                               Var SerialNbr      : LONGINT;
  345.                               Var VolLabel       : STRING;
  346.                               Var FileSysType    : STRING    ) : WORD;
  347.  
  348.  
  349. [PARAMETERS]
  350.  
  351. Drive       Drive Number
  352. InfoLevel   VAR Returned Information Access Level
  353. SerialNbr   VAR Returned Media Serial Number
  354. VolLabel    VAR Returned Media Volume Label
  355. FileSysType VAR Returned Media File System Type
  356.  
  357. [RETURNS]
  358.  
  359. (Function : Operation Error Code)
  360. (VAR      : [InfoLevel] Information Access Level)
  361. (VAR      : [SerialNbr] Media Serial Number)
  362. (VAR      : [VolLabel] Media Volume Label)
  363. (VAR      : [FileSysType] Media File System Type)
  364.  
  365. [DESCRIPTION]
  366.  
  367. [SEE-ALSO]
  368.  
  369. [EXAMPLE]
  370.  
  371.  
  372. ──────────────────────────────────────────────────────────────────────────────
  373.  
  374.  
  375. [FUNCTION]
  376.  
  377. Function DOS_SetMediaID(          Drive          : BYTE;
  378.                                   InfoLevel      : WORD;
  379.                                   SerialNbr      : LONGINT;
  380.                                   VolLabel       : STRING;
  381.                                   FileSysType    : STRING    ) : WORD;
  382.  
  383. [PARAMETERS]
  384.  
  385. Drive       Drive Number
  386. InfoLevel   Information Access Level
  387. SerialNbr   Media Serial Number
  388. VolLabel    Media Volume Label
  389. FileSysType Media File System Type
  390.  
  391. [RETURNS]
  392.  
  393. Operation Error Code ($0000=Success)
  394.  
  395. [DESCRIPTION]
  396.  
  397. [SEE-ALSO]
  398.  
  399. [EXAMPLE]
  400.  
  401.  
  402. ──────────────────────────────────────────────────────────────────────────────
  403.  
  404.  
  405. [FUNCTION]
  406.  
  407. Function DOS_GetExtErrText(   VAR Description    : STRING;
  408.                               VAR ErrCause       : STRING;
  409.                               VAR Recommend      : STRING;
  410.                               VAR ErrSource      : STRING    ) : WORD;
  411.  
  412. [PARAMETERS]
  413.  
  414. Description VAR Returned Error Description Text
  415. ErrCause    VAR Returned Error Cause Text
  416. Recommend   VAR Returned Error Recommendation Text
  417. ErrSource   VAR Returned Error Source Text
  418.  
  419. [RETURNS]
  420.  
  421. (Function : Operation Error Code, $0000=Success)
  422. (VAR      : [Description] Error Description Text)
  423. (VAR      : [ErrCause] Error Cause Text)
  424. (VAR      : [Recommend] Error Recommendation Text)
  425. (VAR      : [ErrSource] Error Source Text)
  426.  
  427. [DESCRIPTION]
  428.  
  429. Reads the Extended DOS Error Information for the last Error Condition
  430. and returns the above information about it.
  431.  
  432. Based upon the Error Code, Returns each of the following:
  433.   1) A Description of the Error Condition
  434.   2) What may have Caused the Problem
  435.   3) A Suggested Course of Action
  436.   4) Device in which Error Occurred.
  437.  
  438. [SEE-ALSO]
  439.  
  440. [EXAMPLE]
  441.  
  442.